Package de.aoksystems.da.kernpruefung.saetze

Interface SatzFactory

public interface SatzFactory
Interface, welches die Anforderungen an Satz-Fabriken definiert. Jedes Verfahren soll seine eigene SatzFactory implementieren, die genau diese Datensätze aus Rohdatenstrings konstruieren kann.
Version:
1.0
Author:
Jens Tröger (AOK-Systems - Datenaustausch)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Satz
    constructSatz(String raw)
    Jede SatzFactory muss die Methode constructSatz(raw) implementieren.
    SatzCip
    getCip(String satzkopf)
    Gibt den SatzCip für den angegebenen Satzkopf zurück.
    String[]
    getSatzkoepfe()
    Gibt ein Array aller Satzkoepfe (9-stellige Strings) zurück, für die diese Fabrikklasse zuständig ist.
    boolean
    isResponsibleFor(String satzkopf)
    Entscheidet, ob die vorliegende Fabrikklasse für einen Satz mit dem Kopf satzkopf zuständig ist.

  • Method Details

    • isResponsibleFor

      boolean isResponsibleFor(String satzkopf)
      Entscheidet, ob die vorliegende Fabrikklasse für einen Satz mit dem Kopf satzkopf zuständig ist. Dieser Methode wird der Satzkopf, bestehend aus Kennung (Stellen 1-4) und Verfahren (Stellen 5-9) eines Datensatzes übergeben. Anhand dieses Strings ist zurückzumelden, ob die Factory grundsätzlich zuständig sein könnte. Der übergebene String kann länger als 9 Zeichen sein, dann werden nur die ersten 9 Zeichen zur Entscheidung verwendet. Es muss in dieser Method keine Aussage getroffen werden, ob aus dem String letztlich auch erfolgreich ein entsprechender Satz konstruiert werden kann.
      Parameters:
      satzkopf - Stellen 1-9 des betrachteten Datensatzes
      Returns:
      true, wenn die Factory zuständig ist, false sonst

    • getCip

      SatzCip getCip(String satzkopf) throws KonstruktionsException
      Gibt den SatzCip für den angegebenen Satzkopf zurück. Die Methode darf nur für diejenigen Satzköpfe einen SatzCip liefern, die im Rückgabewert der Methode getSatzkoepfe() aufgelistet sind.
      Parameters:
      satzkopf - Satzkopf des gewünschten Datensatzes
      Returns:
      SatzCip für diesen Satzkopf.
      Throws:
      KonstruktionsException - wenn zur Kennung kein SatzCip gefunden werden konnte.

    • getSatzkoepfe

      String[] getSatzkoepfe()
      Gibt ein Array aller Satzkoepfe (9-stellige Strings) zurück, für die diese Fabrikklasse zuständig ist. Die Einträge müssen im Rückgabewert nicht unbedingt sortiert vorliegen. Für jeden Eintrag im Rückgabewert muss die Methode getCip(String) auch einen SatzCip zurückliefern können.
      Returns:
      ein Array von Strings, die die Satzkoepfe anzeigen, für die diese Factory zustänfig ist.

    • constructSatz

      Satz constructSatz(String raw) throws KonstruktionsException
      Jede SatzFactory muss die Methode constructSatz(raw) implementieren. Dieser Methode wird ein Rohdatenstring übergeben, aus dem dann der entsprechende Satz zu konstruieren ist. Schlägt die Konstruktion fehl, sollte eine KonstruktionsException geworfen werden.
      Parameters:
      raw - Rohdatenstring
      Returns:
      konstruierter Satz
      Throws:
      KonstruktionsException - wenn aus raw kein Satz konstruiert werden konnte